<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class DefaultSecurityConfiguration</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Class DefaultSecurityConfiguration
</h2> (line <span class="linenumber">38</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_reference---DefaultSecurityConfiguration.php.html">/reference/DefaultSecurityConfiguration.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>Reference Implementation of the SecurityConfiguration interface.</h5>
<ul>
		<li><strong>author:</strong> - Mike Boberski &lt;<a href="mailto:boberski_michael@bah.com">boberski_michael@bah.com</a>&gt;</li>
		<li><strong>author:</strong> - Andrew van der Stock &lt;<a href="mailto:vanderaj@owasp.org">vanderaj@owasp.org</a>&gt;</li>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#method__construct" title="details" class="method-name">__construct</a>
        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">''</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetAllowedExecutables" title="details" class="method-name">getAllowedExecutables</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetAllowedFileExtensions" title="details" class="method-name">getAllowedFileExtensions</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetAllowedFileUploadSize" title="details" class="method-name">getAllowedFileUploadSize</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetAllowedIncludes" title="details" class="method-name">getAllowedIncludes</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetAllowedLoginAttempts" title="details" class="method-name">getAllowedLoginAttempts</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetAllowedResources" title="details" class="method-name">getAllowedResources</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetApplicationName" title="details" class="method-name">getApplicationName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetCharacterEncoding" title="details" class="method-name">getCharacterEncoding</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetDigitalSignatureAlgorithm" title="details" class="method-name">getDigitalSignatureAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetDisableIntrusionDetection" title="details" class="method-name">getDisableIntrusionDetection</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetEncryptionAlgorithm" title="details" class="method-name">getEncryptionAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetHashAlgorithm" title="details" class="method-name">getHashAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetLogApplicationName" title="details" class="method-name">getLogApplicationName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetLogEncodingRequired" title="details" class="method-name">getLogEncodingRequired</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetLogFileDateFormat" title="details" class="method-name">getLogFileDateFormat</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetLogFileName" title="details" class="method-name">getLogFileName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetLogLevel" title="details" class="method-name">getLogLevel</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetMasterKey" title="details" class="method-name">getMasterKey</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetMasterSalt" title="details" class="method-name">getMasterSalt</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetMaxLogFileBackups" title="details" class="method-name">getMaxLogFileBackups</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetMaxLogFileSize" title="details" class="method-name">getMaxLogFileSize</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetMaxOldPasswordHashes" title="details" class="method-name">getMaxOldPasswordHashes</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetPasswordParameterName" title="details" class="method-name">getPasswordParameterName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetQuota" title="details" class="method-name">getQuota</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$eventName</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetRandomAlgorithm" title="details" class="method-name">getRandomAlgorithm</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetRememberTokenDuration" title="details" class="method-name">getRememberTokenDuration</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetResourceDirectory" title="details" class="method-name">getResourceDirectory</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetResponseContentType" title="details" class="method-name">getResponseContentType</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetSessionAbsoluteTimeoutLength" title="details" class="method-name">getSessionAbsoluteTimeoutLength</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetSessionIdleTimeoutLength" title="details" class="method-name">getSessionIdleTimeoutLength</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodgetSpecialDebugging" title="details" class="method-name">getSpecialDebugging</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetUsernameParameterName" title="details" class="method-name">getUsernameParameterName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetValidationPattern" title="details" class="method-name">getValidationPattern</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodgetWorkingDirectory" title="details" class="method-name">getWorkingDirectory</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetResourceDirectory" title="details" class="method-name">setResourceDirectory</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span>)
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="method__construct" id="method__construct"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor __construct</strong> (line <span class="linenumber">112</span>)
 </h4> 
<h4><i>does</i> <strong>__construct(
[string
$path = ''])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>SecurityConfiguration constructor.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $path</strong>: configuration file path.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<a name="methodgetAllowedExecutables" id="methodgetAllowedExecutables"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedExecutables</strong> (line <span class="linenumber">821</span>)
 </h4> 
<h4><i>void</i> <strong>getAllowedExecutables(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetAllowedExecutables">SecurityConfiguration::getAllowedExecutables()</a></dt>
						<dd>getAllowedExecutables returns an array of executables that are allowed to  be run by the Executor.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetAllowedFileExtensions" id="methodgetAllowedFileExtensions"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedFileExtensions</strong> (line <span class="linenumber">529</span>)
 </h4> 
<h4><i>void</i> <strong>getAllowedFileExtensions(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetAllowedFileExtensions">SecurityConfiguration::getAllowedFileExtensions()</a></dt>
						<dd>Gets the allowed file extensions for files that are uploaded to this  application.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetAllowedFileUploadSize" id="methodgetAllowedFileUploadSize"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedFileUploadSize</strong> (line <span class="linenumber">543</span>)
 </h4> 
<h4><i>void</i> <strong>getAllowedFileUploadSize(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetAllowedFileUploadSize">SecurityConfiguration::getAllowedFileUploadSize()</a></dt>
						<dd>Gets the maximum allowed file upload size.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetAllowedIncludes" id="methodgetAllowedIncludes"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedIncludes</strong> (line <span class="linenumber">835</span>)
 </h4> 
<h4><i>void</i> <strong>getAllowedIncludes(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetAllowedIncludes">SecurityConfiguration::getAllowedIncludes()</a></dt>
						<dd>getAllowedIncludes returns an array of include files that are allowed to be  included by PHP. This is a ESAPI extension for PHP</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetAllowedLoginAttempts" id="methodgetAllowedLoginAttempts"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedLoginAttempts</strong> (line <span class="linenumber">417</span>)
 </h4> 
<h4><i>void</i> <strong>getAllowedLoginAttempts(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetAllowedLoginAttempts">SecurityConfiguration::getAllowedLoginAttempts()</a></dt>
						<dd>Gets the number of login attempts allowed before the user's account is  locked. If this many failures are detected within the alloted time period,  the user's account will be locked.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetAllowedResources" id="methodgetAllowedResources"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAllowedResources</strong> (line <span class="linenumber">847</span>)
 </h4> 
<h4><i>void</i> <strong>getAllowedResources(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetAllowedResources">SecurityConfiguration::getAllowedResources()</a></dt>
						<dd>getAllowedResources returns an array of resources (files) that are permitted.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetApplicationName" id="methodgetApplicationName"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getApplicationName</strong> (line <span class="linenumber">389</span>)
 </h4> 
<h4><i>void</i> <strong>getApplicationName(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetApplicationName">SecurityConfiguration::getApplicationName()</a></dt>
						<dd>Gets the application name, used for logging</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetCharacterEncoding" id="methodgetCharacterEncoding"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getCharacterEncoding</strong> (line <span class="linenumber">585</span>)
 </h4> 
<h4><i>void</i> <strong>getCharacterEncoding(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetCharacterEncoding">SecurityConfiguration::getCharacterEncoding()</a></dt>
						<dd>Gets the character encoding scheme supported by this application. This is</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetDigitalSignatureAlgorithm" id="methodgetDigitalSignatureAlgorithm"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getDigitalSignatureAlgorithm</strong> (line <span class="linenumber">599</span>)
 </h4> 
<h4><i>void</i> <strong>getDigitalSignatureAlgorithm(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetDigitalSignatureAlgorithm">SecurityConfiguration::getDigitalSignatureAlgorithm()</a></dt>
						<dd>Gets the digital signature algorithm used by ESAPI to generate and verify  signatures.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetDisableIntrusionDetection" id="methodgetDisableIntrusionDetection"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getDisableIntrusionDetection</strong> (line <span class="linenumber">656</span>)
 </h4> 
<h4><i>void</i> <strong>getDisableIntrusionDetection(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetDisableIntrusionDetection">SecurityConfiguration::getDisableIntrusionDetection()</a></dt>
						<dd>Allows for complete disabling of all intrusion detection mechanisms.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetEncryptionAlgorithm" id="methodgetEncryptionAlgorithm"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getEncryptionAlgorithm</strong> (line <span class="linenumber">557</span>)
 </h4> 
<h4><i>void</i> <strong>getEncryptionAlgorithm(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetEncryptionAlgorithm">SecurityConfiguration::getEncryptionAlgorithm()</a></dt>
						<dd>Gets the encryption algorithm used by ESAPI to protect data.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetHashAlgorithm" id="methodgetHashAlgorithm"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getHashAlgorithm</strong> (line <span class="linenumber">571</span>)
 </h4> 
<h4><i>void</i> <strong>getHashAlgorithm(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetHashAlgorithm">SecurityConfiguration::getHashAlgorithm()</a></dt>
						<dd>Gets the hashing algorithm used by ESAPI to hash data.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetLogApplicationName" id="methodgetLogApplicationName"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogApplicationName</strong> (line <span class="linenumber">700</span>)
 </h4> 
<h4><i>void</i> <strong>getLogApplicationName(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetLogEncodingRequired" id="methodgetLogEncodingRequired"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogEncodingRequired</strong> (line <span class="linenumber">714</span>)
 </h4> 
<h4><i>void</i> <strong>getLogEncodingRequired(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetLogEncodingRequired">SecurityConfiguration::getLogEncodingRequired()</a></dt>
						<dd>Returns whether HTML entity encoding should be applied to log entries.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetLogFileDateFormat" id="methodgetLogFileDateFormat"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogFileDateFormat</strong> (line <span class="linenumber">784</span>)
 </h4> 
<h4><i>void</i> <strong>getLogFileDateFormat(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetLogFileName" id="methodgetLogFileName"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogFileName</strong> (line <span class="linenumber">742</span>)
 </h4> 
<h4><i>void</i> <strong>getLogFileName(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetLogFileName">SecurityConfiguration::getLogFileName()</a></dt>
						<dd>Get the name of the log file specified in the ESAPI configuration properties  file. Return a default value if it is not specified.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetLogLevel" id="methodgetLogLevel"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLogLevel</strong> (line <span class="linenumber">728</span>)
 </h4> 
<h4><i>void</i> <strong>getLogLevel(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetLogLevel">SecurityConfiguration::getLogLevel()</a></dt>
						<dd>Get the log level specified in the ESAPI configuration properties file.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetMasterKey" id="methodgetMasterKey"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMasterKey</strong> (line <span class="linenumber">501</span>)
 </h4> 
<h4><i>void</i> <strong>getMasterKey(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetMasterKey">SecurityConfiguration::getMasterKey()</a></dt>
						<dd>Gets the master password. This password can be used to encrypt/decrypt other  files or types of data that need to be protected by your application.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetMasterSalt" id="methodgetMasterSalt"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMasterSalt</strong> (line <span class="linenumber">515</span>)
 </h4> 
<h4><i>void</i> <strong>getMasterSalt(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetMasterSalt">SecurityConfiguration::getMasterSalt()</a></dt>
						<dd>Gets the master salt that is used to salt stored password hashes and any  other location where a salt is needed.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetMaxLogFileBackups" id="methodgetMaxLogFileBackups"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMaxLogFileBackups</strong> (line <span class="linenumber">770</span>)
 </h4> 
<h4><i>void</i> <strong>getMaxLogFileBackups(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetMaxLogFileSize" id="methodgetMaxLogFileSize"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMaxLogFileSize</strong> (line <span class="linenumber">756</span>)
 </h4> 
<h4><i>void</i> <strong>getMaxLogFileSize(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetMaxLogFileSize">SecurityConfiguration::getMaxLogFileSize()</a></dt>
						<dd>Get the maximum size of a single log file from the ESAPI configuration  properties file. Return a default value if it is not specified. Once the  log hits this file size, it will roll over into a new log.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetMaxOldPasswordHashes" id="methodgetMaxOldPasswordHashes"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getMaxOldPasswordHashes</strong> (line <span class="linenumber">431</span>)
 </h4> 
<h4><i>void</i> <strong>getMaxOldPasswordHashes(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetMaxOldPasswordHashes">SecurityConfiguration::getMaxOldPasswordHashes()</a></dt>
						<dd>Gets the maximum number of old password hashes that should be retained.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetPasswordParameterName" id="methodgetPasswordParameterName"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getPasswordParameterName</strong> (line <span class="linenumber">445</span>)
 </h4> 
<h4><i>void</i> <strong>getPasswordParameterName(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetPasswordParameterName">SecurityConfiguration::getPasswordParameterName()</a></dt>
						<dd>Gets the name of the password parameter used during user authentication.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetQuota" id="methodgetQuota"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getQuota</strong> (line <span class="linenumber">627</span>)
 </h4> 
<h4><i>void</i> <strong>getQuota(

$eventName)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetQuota">SecurityConfiguration::getQuota()</a></dt>
						<dd>Gets the intrusion detection quota for the specified event.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $eventName</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetRandomAlgorithm" id="methodgetRandomAlgorithm"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRandomAlgorithm</strong> (line <span class="linenumber">613</span>)
 </h4> 
<h4><i>void</i> <strong>getRandomAlgorithm(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetRandomAlgorithm">SecurityConfiguration::getRandomAlgorithm()</a></dt>
						<dd>Gets the random number generation algorithm used to generate random numbers  where needed.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetRememberTokenDuration" id="methodgetRememberTokenDuration"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRememberTokenDuration</strong> (line <span class="linenumber">403</span>)
 </h4> 
<h4><i>void</i> <strong>getRememberTokenDuration(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetRememberTokenDuration">SecurityConfiguration::getRememberTokenDuration()</a></dt>
						<dd>Gets the length of the time to live window for remember me tokens (in  milliseconds).</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetResourceDirectory" id="methodgetResourceDirectory"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getResourceDirectory</strong> (line <span class="linenumber">670</span>)
 </h4> 
<h4><i>void</i> <strong>getResourceDirectory(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetResourceDirectory">SecurityConfiguration::getResourceDirectory()</a></dt>
						<dd>Gets the name of the ESAPI resource directory as a String.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetResponseContentType" id="methodgetResponseContentType"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getResponseContentType</strong> (line <span class="linenumber">686</span>)
 </h4> 
<h4><i>void</i> <strong>getResponseContentType(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetResponseContentType">SecurityConfiguration::getResponseContentType()</a></dt>
						<dd>Gets the content type for responses used when setSafeContentType() is called.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetSessionAbsoluteTimeoutLength" id="methodgetSessionAbsoluteTimeoutLength"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getSessionAbsoluteTimeoutLength</strong> (line <span class="linenumber">487</span>)
 </h4> 
<h4><i>void</i> <strong>getSessionAbsoluteTimeoutLength(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetSessionAbsoluteTimeoutLength">SecurityConfiguration::getSessionAbsoluteTimeoutLength()</a></dt>
						<dd>Gets the absolute timeout length for sessions (in milliseconds). This is</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetSessionIdleTimeoutLength" id="methodgetSessionIdleTimeoutLength"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getSessionIdleTimeoutLength</strong> (line <span class="linenumber">473</span>)
 </h4> 
<h4><i>void</i> <strong>getSessionIdleTimeoutLength(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetSessionIdleTimeoutLength">SecurityConfiguration::getSessionIdleTimeoutLength()</a></dt>
						<dd>Gets the idle timeout length for sessions (in milliseconds). This is the  amount of time that a session can live before it expires due to lack of  activity. Applications or frameworks could provide a reauthenticate  function that enables a session to continue after reauthentication.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetSpecialDebugging" id="methodgetSpecialDebugging"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getSpecialDebugging</strong> (line <span class="linenumber">865</span>)
 </h4> 
<h4><i>bool</i> <strong>getSpecialDebugging(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>getSpecialDebugging returns boolean true if special debugging should be  enabled. Default is false.</h5>
<div class="desc"><p>At the moment, special debugging is used for producing output from  CodecDebug.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - True if special debugging should be enabled. Default is false.</li>
		</ul>
</div>
<a name="methodgetUsernameParameterName" id="methodgetUsernameParameterName"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getUsernameParameterName</strong> (line <span class="linenumber">459</span>)
 </h4> 
<h4><i>void</i> <strong>getUsernameParameterName(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetUsernameParameterName">SecurityConfiguration::getUsernameParameterName()</a></dt>
						<dd>Gets the name of the username parameter used during user authentication.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetValidationPattern" id="methodgetValidationPattern"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getValidationPattern</strong> (line <span class="linenumber">798</span>)
 </h4> 
<h4><i>void</i> <strong>getValidationPattern(

$type)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetValidationPattern">SecurityConfiguration::getValidationPattern()</a></dt>
						<dd>Get the specified validation pattern from the ESAPI configuration properties  file.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $type</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetWorkingDirectory" id="methodgetWorkingDirectory"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getWorkingDirectory</strong> (line <span class="linenumber">806</span>)
 </h4> 
<h4><i>void</i> <strong>getWorkingDirectory(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodgetWorkingDirectory">SecurityConfiguration::getWorkingDirectory()</a></dt>
						<dd>getWorkingDirectory returns the default directory where processes will be  executed by the Executor.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetResourceDirectory" id="methodsetResourceDirectory"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setResourceDirectory</strong> (line <span class="linenumber">678</span>)
 </h4> 
<h4><i>void</i> <strong>setResourceDirectory(

$dir)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/SecurityConfiguration.html#methodsetResourceDirectory">SecurityConfiguration::setResourceDirectory()</a></dt>
						<dd>Sets the ESAPI resource directory.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $dir</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Thu, 20 May 2010 16:30:21 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>